using Baci.Net.ToolKit.ArcGISProGeoprocessor.Models;
using Baci.Net.ToolKit.ArcGISProGeoprocessor.Models.Attributes;
using Baci.Net.ToolKit.ArcGISProGeoprocessor.Models.Attributes.DomainAttributes;
using Baci.Net.ToolKit.ArcGISProGeoprocessor.Models.Enums;
using System.Collections.Generic;
using System.ComponentModel;

namespace Baci.ArcGIS._SpatialAnalystTools._Surface
{
    /// <summary>
    /// <para>Cut Fill</para>
    /// <para>Calculates the volume change between two surfaces. This is typically used for cut and fill operations.</para>
    /// <para>计算两个曲面之间的体积变化。这通常用于切割和填充操作。</para>
    /// </summary>    
    [DisplayName("Cut Fill")]
    public class CutFill : AbstractGPProcess
    {
        /// <summary>
        /// 无参构造
        /// </summary>
        public CutFill()
        {

        }

        /// <summary>
        /// 有参构造
        /// </summary>
        /// <param name="_in_before_surface">
        /// <para>Input before raster surface</para>
        /// <para>The input representing the surface before the cut or fill operation.</para>
        /// <para>表示切割或填充操作之前的曲面的输入。</para>
        /// </param>
        /// <param name="_in_after_surface">
        /// <para>Input after raster surface</para>
        /// <para>The input representing the surface after the cut or fill operation.</para>
        /// <para>表示切割或填充操作后的曲面的输入。</para>
        /// </param>
        /// <param name="_out_raster">
        /// <para>Output raster</para>
        /// <para><xdoc>
        ///   <para>The output raster defining regions of cut and of fill.</para>
        ///   <para>The values show the locations and amounts where the surface has been added to or removed from.</para>
        /// </xdoc></para>
        /// <para><xdoc>
        ///   <para>定义切口和填充区域的输出栅格。</para>
        ///   <para>这些值显示表面已添加或移除的位置和数量。</para>
        /// </xdoc></para>
        /// </param>
        public CutFill(object _in_before_surface, object _in_after_surface, object _out_raster)
        {
            this._in_before_surface = _in_before_surface;
            this._in_after_surface = _in_after_surface;
            this._out_raster = _out_raster;
        }
        public override string ToolboxName => "Spatial Analyst Tools";

        public override string ToolName => "Cut Fill";

        public override string CallName => "sa.CutFill";

        public override List<string> AcceptEnvironments => ["autoCommit", "cellSize", "cellSizeProjectionMethod", "compression", "configKeyword", "extent", "geographicTransformations", "mask", "outputCoordinateSystem", "scratchWorkspace", "snapRaster", "tileSize", "workspace"];

        public override object[] ParameterInfo => [_in_before_surface, _in_after_surface, _out_raster, _z_factor];

        /// <summary>
        /// <para>Input before raster surface</para>
        /// <para>The input representing the surface before the cut or fill operation.</para>
        /// <para>表示切割或填充操作之前的曲面的输入。</para>
        /// <para></para>
        /// </summary>
        [DisplayName("Input before raster surface")]
        [Description("")]
        [Option(OptionTypeEnum.Must)]
        public object _in_before_surface { get; set; }


        /// <summary>
        /// <para>Input after raster surface</para>
        /// <para>The input representing the surface after the cut or fill operation.</para>
        /// <para>表示切割或填充操作后的曲面的输入。</para>
        /// <para></para>
        /// </summary>
        [DisplayName("Input after raster surface")]
        [Description("")]
        [Option(OptionTypeEnum.Must)]
        public object _in_after_surface { get; set; }


        /// <summary>
        /// <para>Output raster</para>
        /// <para><xdoc>
        ///   <para>The output raster defining regions of cut and of fill.</para>
        ///   <para>The values show the locations and amounts where the surface has been added to or removed from.</para>
        /// </xdoc></para>
        /// <para><xdoc>
        ///   <para>定义切口和填充区域的输出栅格。</para>
        ///   <para>这些值显示表面已添加或移除的位置和数量。</para>
        /// </xdoc></para>
        /// <para></para>
        /// </summary>
        [DisplayName("Output raster")]
        [Description("")]
        [Option(OptionTypeEnum.Must)]
        public object _out_raster { get; set; }


        /// <summary>
        /// <para>Z factor</para>
        /// <para><xdoc>
        ///   <para>The number of ground x,y units in one surface z-unit.</para>
        ///   <para>The z-factor adjusts the units of measure for the z-units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface.</para>
        ///   <para>If the x,y units and z-units are in the same units of measure, the z-factor is 1. This is the default.</para>
        ///   <para>If the x,y units and z-units are in different units of measure, the z-factor must be set to the appropriate factor or the results will be incorrect. For example, if the z-units are feet and the x,y units are meters, you would use a z-factor of 0.3048 to convert the z-units from feet to meters (1 foot = 0.3048 meter).</para>
        /// </xdoc></para>
        /// <para><xdoc>
        ///   <para>一个曲面 z 单位中的地面 x，y 单位数。</para>
        ///   <para>当 z 单位与输入表面的 x，y 单位不同时，z 因子会调整它们的测量单位。在计算最终输出曲面时，输入曲面的 z 值乘以 z 因子。</para>
        ///   <para>如果 x，y 单位和 z 单位采用相同的测量单位，则 z 因子为 1。这是默认设置。</para>
        ///   <para>如果 x，y 单位和 z 单位采用不同的测量单位，则必须将 z 因子设置为适当的因子，否则结果将不正确。例如，如果 z 单位是英尺，x，y 单位是米，则使用 z 因子 0.3048 将 z 单位从英尺转换为米 （1 英尺 = 0.3048 米）。</para>
        /// </xdoc></para>
        /// <para></para>
        /// </summary>
        [DisplayName("Z factor")]
        [Description("")]
        [Option(OptionTypeEnum.optional)]
        public double _z_factor { get; set; } = 1;


        public CutFill SetEnv(int? autoCommit = null, object cellSize = null, object compression = null, object configKeyword = null, object extent = null, object geographicTransformations = null, object mask = null, object outputCoordinateSystem = null, object scratchWorkspace = null, object snapRaster = null, double[] tileSize = null, object workspace = null)
        {
            base.SetEnv(autoCommit: autoCommit, cellSize: cellSize, compression: compression, configKeyword: configKeyword, extent: extent, geographicTransformations: geographicTransformations, mask: mask, outputCoordinateSystem: outputCoordinateSystem, scratchWorkspace: scratchWorkspace, snapRaster: snapRaster, tileSize: tileSize, workspace: workspace);
            return this;
        }

    }

}